Add GitHub Enterprise support by arhowe00 · Pull Request #3720 · Kitware/CDash

arhowe00 · 2026-05-13T02:51:17Z

This change makes it easier to configure GitHub integration for users who may use a private GHE instance. CDash's GitHub integration (check runs, commit statuses, PR comments) is currently hardcoded to api.github.com.

Could the reviewer look at (1) how I change GitHubClient as well as (2) whether these changes are reasonable?

(1) You can see that constructing with null as the api version sets it to 'v3' which is the version that the only enterprise client I'm aware of uses. Why is it currently 'machine-man-preview'?
(2) I changed this so checks are always posted if there is a revision. It seems this flag is now read-only. I've added another commit to guard createOrUpdateCheck, since if ($revision !== '') fires for any project regardless of whether it's actually configured with GHE

Enable CDash to post check runs and commit statuses to ghe installations in addition to github.com. Changes: - Add GITHUB_ENTERPRISE_URL config option (env var) - Pass enterprise URL to GitHubClient constructor with apiVersion=null (so it defaults to 'v3') so the PathPrepend plugin builds correct /api/v3/ paths for ghe - Add isGitHubUrl() helpers in GitHub.php and RepositoryUtils.php to match repository URLs against both github.com and the configured GHE host - Convert get_github_api_url() to construct /api/v3/repos/ paths for GHE repositories - Make DoneHandler always create/update the check when a revision exists, rather than requiring the pendingSubmissions recheck flag

…rvice

williamjallen · 2026-06-02T20:28:42Z

        $builder = new GitHubBuilder();
-        $apiClient = new GitHubClient($builder, 'machine-man-preview');
+        $enterpriseUrl = config('cdash.github_enterprise_url');
+        $apiClient = new GitHubClient($builder, null, is_string($enterpriseUrl) ? $enterpriseUrl : null);


You should treat an empty string like a null here.

williamjallen · 2026-06-02T20:32:47Z

+        $enterpriseUrl = config('cdash.github_enterprise_url');
+        if (is_string($enterpriseUrl)) {
+            $host = parse_url($enterpriseUrl, PHP_URL_HOST);
+            return is_string($host) && str_contains($url, $host);
+        }


You're referencing the config value multiple times in this file. It would be better to factor that out into a method which returns the enterprise URL or null.

williamjallen · 2026-06-02T20:33:50Z

-        $repositoryInterface = self::getRepositoryInterface($project);
+        try {
+            $repositoryInterface = self::getRepositoryInterface($project);
+        } catch (Exception $e) {
+            return;
+        }


Why is this necessary? This will destroy all exceptions within getRepositoryInterface(), preventing them from making it to the logs.

williamjallen · 2026-06-02T20:34:36Z

-            // Should we re-run any checks that were previously marked
-            // as pending?
-            if ($pendingSubmissionsModel !== null && $pendingSubmissionsModel->recheck) {
-                $revision = \App\Models\Build::findOrFail((int) $this->Build->Id)->updateStep->revision ?? '';
+            // Create or update the GitHub check for this commit.
+            $revision = \App\Models\Build::findOrFail((int) $this->Build->Id)->updateStep->revision ?? '';
+            if ($revision !== '') {


What's the thought process here?

williamjallen · 2026-06-02T20:35:48Z

+    private static function isGitHubUrl(string $url): bool
+    {
+        if (str_contains($url, 'github.com')) {
+            return true;
+        }
+        $enterpriseUrl = config('cdash.github_enterprise_url');
+        if (is_string($enterpriseUrl)) {
+            $host = parse_url($enterpriseUrl, PHP_URL_HOST);
+            return is_string($host) && str_contains($url, $host);
+        }
+        return false;
+    }


This is a duplicate of isGitHubUrl() in app/cdash/app/Lib/Repository/GitHub.php. Let's remove the one in app/cdash/app/Lib/Repository/GitHub.php.

williamjallen · 2026-06-02T20:37:47Z

+        }
+        $enterpriseUrl = config('cdash.github_enterprise_url');
+        if (is_string($enterpriseUrl)) {
+            $host = parse_url($enterpriseUrl, PHP_URL_HOST);


You can use Laravel's Uri facade to do this more eloquently (note: untested).

Apply throughout.

Suggested change

$host = parse_url($enterpriseUrl, PHP_URL_HOST);

$host = Uri::of($enterpriseUrl)->host();

williamjallen · 2026-06-02T20:40:57Z

+        $enterpriseUrl = config('cdash.github_enterprise_url');
+        if (is_string($enterpriseUrl)) {
+            $host = parse_url($enterpriseUrl, PHP_URL_HOST);
+            if (is_string($host)) {
+                $idx = strpos($github_url, $host);
+                if ($idx !== false) {
+                    // For GHE, ...://<host>/<user>/<repo> becomes ...://<host>/api/v3/repos/<user>/<repo>
+                    $idx2 = $idx + strlen($host) + 1;
+                    $api_url = substr($github_url, 0, $idx) . $host . '/api/v3/repos/';
+                    $api_url .= substr($github_url, $idx2);
+                    return $api_url;
+                }
+            }
+        }


A few questions/comments:

Can you please add a comment explaining what's going on here?

Does ...<host>/api/v3... work for GitHub.com too? i.e., are we strictly required to have a GHE-specific code path here?

Assuming we need a GHE-specific code path, can you wrap the following code in an else so it's clear that there are two branches? It took a second for me to understand what was going on here.

There are probably Laravel string facade methods which could make this cleaner.

williamjallen · 2026-06-02T20:43:23Z

@arhowe00 Note that CDash squashes commits, so your PR description will be included in the git history permanently. Please leave any questions/comments as comments on GitHub and treat the PR description as the commit message.

williamjallen added this to the v5.1 milestone May 14, 2026

williamjallen added the release notes: features label May 14, 2026

arhowe00 force-pushed the add-ghe-support branch from bd69154 to 0ad030b Compare May 29, 2026 19:45

williamjallen self-requested a review June 1, 2026 12:47

arhowe00 force-pushed the add-ghe-support branch from 0ad030b to 7485892 Compare June 1, 2026 14:10

arhowe00 added 2 commits June 2, 2026 16:05

Guard createOrUpdateCheck with try/catch; inspired by getRepositorySe…

000d859

…rvice

Fix PHPStan warnings

2928d72

williamjallen requested changes Jun 2, 2026

View reviewed changes

williamjallen changed the title ~~Add ghe support~~ Add GitHub Enterprise support Jun 2, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GitHub Enterprise support#3720

Add GitHub Enterprise support#3720
arhowe00 wants to merge 3 commits into
Kitware:masterfrom
arhowe00:add-ghe-support

arhowe00 commented May 13, 2026 •

edited

Loading

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen Jun 2, 2026

Uh oh!

williamjallen commented Jun 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	$host = parse_url($enterpriseUrl, PHP_URL_HOST);
	$host = Uri::of($enterpriseUrl)->host();

Conversation

arhowe00 commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen Jun 2, 2026

Choose a reason for hiding this comment

Uh oh!

williamjallen commented Jun 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arhowe00 commented May 13, 2026 •

edited

Loading